Wikiman教程-一个离线文档搜索利器

316次阅读
没有评论

共计1743个字符,预计需要花费5分钟才能阅读完成。

简介

Wikiman 是一个离线文档搜索引擎,可以搜索各种 Wiki 和文档。
此外,该工具还提供一个简单的浏览界面,不仅能够搜索内容,更能进行内容过滤。

下载地址

Wikiman 项目在 Github 上可以搜到:
https://github.com/filiparag/wikiman

国内的镜像:
https://gitcode.com/gh_mirrors/wi/wikiman

安装方法

安装方法 README.md 里面可以查看,我这里翻译了一下。下载的所有文件都在 Release 页面。

Arch Linux

通过官方库就能安装,输入一下命令:

pacman -S wikiman
# 以下命令是可选的,用于开启 Arch Wiki
pacman -S arch-wiki-docs

如果你运行的是 Manjaro 或者其他基于 Arch 分支, 下载最新的 .pkg.tar.zst 安装包,输入一下命令来安装:

sudo pacman -U wikiman*.pkg.tar.zst

Ubuntu / Debian

下载最新的 .deb 包,然后安装:

sudo apt update
sudo apt install ./wikiman*.deb

Fedora / openSUSE

下载最新的 .rpm 包。

Fedora

sudo dnf install wikiman*.rpm

openSUSE

注意跳过签名验证。

sudo zypper in wikiman*.rpm

FreeBSD

安装 textproc/wikiman 通过 Ports Collection

portsnap auto
cd /usr/ports/textproc/wikiman
make install

或者下载最新的 .txz 包并安装:

pkg install wikiman*.txz

其他 Linux 或者 BSD 系统

必须先安装依赖包:man, fzf, ripgrep, awk, w3m, coreutils, parallel

# 从 GitHub 克隆项目
git clone 'https://github.com/filiparag/wikiman'
cd ./wikiman

# 选择最新的稳定版 (可选)
git checkout $(git describe --tags | cut -d'-' -f1)

# 可用的构建: all, core, widgets, completions, config, docs
make all

# 对于 BSD 系统: 安装到 /usr/local 目录下
make local

# 安装 Wikiman
sudo make install

Wikiman 使用 find 和 awk 命令,所以使用 BSD 系统的用户应该先安装 findutils 和 gawk。

快速使用

修改配置文件

以下是默认的配置文件,位于 /etc/wikiman.conf

# Sources (if empty, use all available)
sources = 

# Fuzzy finder
fuzzy_finder = fzf

# Quick search mode (only by title)
quick_search = false

# AND operator mode (must contain all keywords)
and_operator = false

# Raw output (for developers)
raw_output = false

# Manpages language(s)
man_lang = en

# Wiki language(s)
wiki_lang = en

# Show previews in TUI
tui_preview = true

# Keep open after viewing a result
tui_keep_open = false

# Show source column
tui_source_column = false

# Viewer for HTML pages
tui_html = w3m

我们 sudo vim /etc/wikiman.confvim 修改文件,将 man_langwiki_lang 设置为 zh-CN 可以将文档设置为中文模式。

快速查看文档

输入 wikiman -S 可以列出所有可用的文档:

Wikiman 教程 - 一个离线文档搜索利器

输入 wikiman 命令进入界面模式:

Wikiman 教程 - 一个离线文档搜索利器

键盘输入 clang 即可查找有关 clang 的文档:

Wikiman 教程 - 一个离线文档搜索利器

按下 回车键 就可以进入阅读文档:

Wikiman 教程 - 一个离线文档搜索利器

在这个界面输入 h 查看帮助,输入 q 退出程序。

指定查看中文的文档,输入命令:

wikiman -l zh_CN

Wikiman 教程 - 一个离线文档搜索利器

正文完
 0
评论(没有评论)
验证码
zh_CN简体中文